/*
 * ====================================================================
 * 
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2003 Nick Lothian. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:  
 *       "This product includes software developed by the 
 *        developers of Classifier4J (http://classifier4j.sf.net/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The name "Classifier4J" must not be used to endorse or promote 
 *    products derived from this software without prior written 
 *    permission. For written permission, please contact   
 *    http://sourceforge.net/users/nicklothian/.
 *
 * 5. Products derived from this software may not be called 
 *    "Classifier4J", nor may "Classifier4J" appear in their names 
 *    without prior written permission. For written permission, please 
 *    contact http://sourceforge.net/users/nicklothian/.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 */
package com.weaver.classifier.bayesian;

import com.weaver.classifier.exception.WordsDataSourceException;

/**
 * Interface used by BayesianClassifier to determine the probability of each 
 * word based on a particular category.
 *
 * @author Nick Lothian
 * @author Peter Leschev
 */
public interface ICategorisedWordsDataSource extends IWordsDataSource {
    /**
     * @param category the category to check against
     * @param word The word to calculate the probability of
     * @return The word probability if the word exists, null otherwise;
         *
         * @throws WordsDataSourceException If there is a fatal problem. For
         *         example, the database is unavailable
     */
    public WordProbability getWordProbability(String category, String word) throws WordsDataSourceException;

    /**
     * Add a matching word to the data source
     * 
     * @param category the category add the match to
     * @param word the word that matches	 
         *
         * @throws WordsDataSourceException If there is a fatal problem. For 
         *         example, the database is unavailable
     */
    public void addMatch(String category, String word) throws WordsDataSourceException;

    /**
     * Add a non-matching word to the data source
     *
     * @param category the category add the non-match to 
     * @param word the word that does not match
         *
         * @throws WordsDataSourceException If there is a fatal problem. For 
         *         example, the database is unavailable
     */
    public void addNonMatch(String category, String word) throws WordsDataSourceException;
}
